Azure Communication Chat Service (stable:2025-03-15)

2025/06/17 • 16 new methods

ChatThread_ListChatReadReceipts (new)
Description :  Gets chat message read receipts for a thread.
Reference :  Link ¶

⚼ Request

GET:  /chat/threads/{chatThreadId}/readReceipts
{
chatThreadId:
{
Description: Thread id to get the chat message read receipts for. ,
Required: True ,
}
string ,
maxPageSize:
{
Description: The maximum number of chat message read receipts to be returned per page. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: Skips chat message read receipts up to a specified position in response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of chat message read receipts. ,
Required: True ,
}
[
{
senderCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
chatMessageId:
{
Description: Id of the chat message that has been read. This id is generated by the server. ,
Required: True ,
}
string ,
readOn:
{
Description: The time at which the message was read. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: If there are more chat message read receipts that can be retrieved, the next link will be populated. ,
Required: False ,
}
string ,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_SendChatReadReceipt (new)
Description :  Sends a read receipt event to a thread, on behalf of a user.
Reference :  Link ¶

⚼ Request

POST:  /chat/threads/{chatThreadId}/readReceipts
{
chatThreadId:
{
Description: Thread id to send the read receipt event to. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
sendReadReceiptRequest:
{
Description: Read receipt details. ,
Required: True ,
}
{
chatMessageId:
{
Description: Id of the latest chat message read by the user. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_SendChatMessage (new)
Description :  Sends a message to a thread.
Reference :  Link ¶

⚼ Request

POST:  /chat/threads/{chatThreadId}/messages
{
chatThreadId:
{
Description: The thread id to send the message to. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
sendChatMessageRequest:
{
Description: Details of the message to send. ,
Required: True ,
}
{
content:
{
Description: Chat message content. ,
Required: True ,
}
string ,
senderDisplayName:
{
Description: The display name of the chat message sender. This property is used to populate sender name for push notifications. ,
Required: False ,
}
string ,
type:
{
Description: The chat message type. ,
Enum:
{
text: No description available. ,
html: No description available. ,
topicUpdated: No description available. ,
participantAdded: No description available. ,
participantRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Message metadata. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
id:
{
Description: A server-generated message id. ,
Required: True ,
}
string ,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_ListChatMessages (new)
Description :  Gets a list of messages from a thread.
Reference :  Link ¶

⚼ Request

GET:  /chat/threads/{chatThreadId}/messages
{
chatThreadId:
{
Description: The thread id of the message. ,
Required: True ,
}
string ,
maxPageSize:
{
Description: The maximum number of messages to be returned per page. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The earliest point in time to get messages after. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of chat messages. ,
Required: True ,
}
[
{
id:
{
Description: The id of the chat message. This id is server generated. ,
Required: True ,
}
string ,
type:
{
Description: The chat message type. ,
Enum:
{
text: No description available. ,
html: No description available. ,
topicUpdated: No description available. ,
participantAdded: No description available. ,
participantRemoved: No description available. ,
}
,
Required: True ,
}
enum ,
sequenceId:
{
Description: Sequence of the chat message in the conversation. ,
Required: True ,
}
string ,
version:
{
Description: Version of the chat message. ,
Required: True ,
}
string ,
content:
{
Description: Content of a chat message. ,
Required: False ,
}
{
message:
{
Description: Chat message content for messages of types text or html. ,
Required: False ,
}
string ,
topic:
{
Description: Chat message content for messages of type topicUpdated. ,
Required: False ,
}
string ,
participants:
{
Description: Chat message content for messages of types participantAdded or participantRemoved. ,
Required: False ,
}
[
{
communicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
displayName:
{
Description: Display name for the chat participant. ,
Required: False ,
}
string ,
shareHistoryTime:
{
Description: Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
}
,
]
,
attachments:
{
Description: List of attachments for this message ,
Required: False ,
}
[
{
id:
{
Description: Id of the attachment ,
Required: True ,
}
string ,
attachmentType:
{
Description: The type of attachment. ,
Enum:
{
image: No description available. ,
file: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the attachment content. ,
Required: False ,
}
string ,
url:
{
Description: The URL where the attachment can be downloaded ,
Format: uri ,
Required: False ,
}
string ,
previewUrl:
{
Description: The URL where the preview of attachment can be downloaded ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
initiatorCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
senderDisplayName:
{
Description: The display name of the chat message sender. This property is used to populate sender name for push notifications. ,
Required: False ,
}
string ,
createdOn:
{
Description: The timestamp when the chat message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
senderCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
deletedOn:
{
Description: The timestamp (if applicable) when the message was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
editedOn:
{
Description: The last timestamp (if applicable) when the message was edited. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Message metadata. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: If there are more chat messages that can be retrieved, the next link will be populated. ,
Required: False ,
}
string ,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_GetChatMessage (new)
Description :  Gets a message by id.
Reference :  Link ¶

⚼ Request

GET:  /chat/threads/{chatThreadId}/messages/{chatMessageId}
{
chatThreadId:
{
Description: The thread id to which the message was sent. ,
Required: True ,
}
string ,
chatMessageId:
{
Description: The message id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the chat message. This id is server generated. ,
Required: True ,
}
string ,
type:
{
Description: The chat message type. ,
Enum:
{
text: No description available. ,
html: No description available. ,
topicUpdated: No description available. ,
participantAdded: No description available. ,
participantRemoved: No description available. ,
}
,
Required: True ,
}
enum ,
sequenceId:
{
Description: Sequence of the chat message in the conversation. ,
Required: True ,
}
string ,
version:
{
Description: Version of the chat message. ,
Required: True ,
}
string ,
content:
{
Description: Content of a chat message. ,
Required: False ,
}
{
message:
{
Description: Chat message content for messages of types text or html. ,
Required: False ,
}
string ,
topic:
{
Description: Chat message content for messages of type topicUpdated. ,
Required: False ,
}
string ,
participants:
{
Description: Chat message content for messages of types participantAdded or participantRemoved. ,
Required: False ,
}
[
{
communicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
displayName:
{
Description: Display name for the chat participant. ,
Required: False ,
}
string ,
shareHistoryTime:
{
Description: Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
}
,
]
,
attachments:
{
Description: List of attachments for this message ,
Required: False ,
}
[
{
id:
{
Description: Id of the attachment ,
Required: True ,
}
string ,
attachmentType:
{
Description: The type of attachment. ,
Enum:
{
image: No description available. ,
file: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the attachment content. ,
Required: False ,
}
string ,
url:
{
Description: The URL where the attachment can be downloaded ,
Format: uri ,
Required: False ,
}
string ,
previewUrl:
{
Description: The URL where the preview of attachment can be downloaded ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
initiatorCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
senderDisplayName:
{
Description: The display name of the chat message sender. This property is used to populate sender name for push notifications. ,
Required: False ,
}
string ,
createdOn:
{
Description: The timestamp when the chat message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
senderCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
deletedOn:
{
Description: The timestamp (if applicable) when the message was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
editedOn:
{
Description: The last timestamp (if applicable) when the message was edited. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Message metadata. ,
Required: False ,
}
object ,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_UpdateChatMessage (new)
Description :  Updates a message.
Reference :  Link ¶

⚼ Request

PATCH:  /chat/threads/{chatThreadId}/messages/{chatMessageId}
{
chatThreadId:
{
Description: The thread id to which the message was sent. ,
Required: True ,
}
string ,
chatMessageId:
{
Description: The message id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
updateChatMessageRequest:
{
Description: Details of the request to update the message. ,
Required: True ,
}
{
content:
{
Description: Chat message content. ,
Required: False ,
}
string ,
metadata:
{
Description: Message metadata. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (204)

{}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_DeleteChatMessage (new)
Description :  Deletes a message.
Reference :  Link ¶

⚼ Request

DELETE:  /chat/threads/{chatThreadId}/messages/{chatMessageId}
{
chatThreadId:
{
Description: The thread id to which the message was sent. ,
Required: True ,
}
string ,
chatMessageId:
{
Description: The message id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_ListChatParticipants (new)
Description :  Gets the participants of a thread.
Reference :  Link ¶

⚼ Request

GET:  /chat/threads/{chatThreadId}/participants
{
chatThreadId:
{
Description: Thread id to get participants for. ,
Required: True ,
}
string ,
maxPageSize:
{
Description: The maximum number of participants to be returned per page. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: Skips participants up to a specified position in response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Chat participants. ,
Required: True ,
}
[
{
communicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
displayName:
{
Description: Display name for the chat participant. ,
Required: False ,
}
string ,
shareHistoryTime:
{
Description: Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: If there are more chat participants that can be retrieved, the next link will be populated. ,
Required: False ,
}
string ,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_RemoveChatParticipant (new)
Description :  Remove a participant from a thread.
Reference :  Link ¶

⚼ Request

POST:  /chat/threads/{chatThreadId}/participants/:remove
{
chatThreadId:
{
Description: Thread id to remove the participant from. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
participantCommunicationIdentifier:
{
Description: Id of the thread participant to remove from the thread. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_AddChatParticipants (new)
Description :  Adds thread participants to a thread. If participants already exist, no change occurs.
Reference :  Link ¶

⚼ Request

POST:  /chat/threads/{chatThreadId}/participants/:add
{
chatThreadId:
{
Description: Id of the thread to add participants to. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
addChatParticipantsRequest:
{
Description: Thread participants to be added to the thread. ,
Required: True ,
}
{
participants:
{
Description: Participants to add to a chat thread. ,
Required: True ,
}
[
{
communicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
displayName:
{
Description: Display name for the chat participant. ,
Required: False ,
}
string ,
shareHistoryTime:
{
Description: Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
invalidParticipants:
{
Description: The participants that failed to be added to the chat thread. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
Chat_CreateChatThread (new)
Description :  Creates a chat thread.
Reference :  Link ¶

⚼ Request

POST:  /chat/threads
{
repeatability-request-id:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
createChatThreadRequest:
{
Description: Request payload for creating a chat thread. ,
Required: True ,
}
{
topic:
{
Description: The chat thread topic. ,
Required: True ,
}
string ,
participants:
{
Description: Participants to be added to the chat thread. ,
Required: False ,
}
[
{
communicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
displayName:
{
Description: Display name for the chat participant. ,
Required: False ,
}
string ,
shareHistoryTime:
{
Description: Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
}
,
]
,
metadata:
{
Description: Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
retentionPolicy:
{
Description: Data retention policy for auto deletion. ,
Required: False ,
}
{
kind:
{
Description: Retention Policy Type ,
Enum:
{
threadCreationDate: Thread retention policy based on thread creation date. ,
none: No thread retention policy ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
chatThread:
{
Description: Chat thread. ,
Required: False ,
}
{
id:
{
Description: Chat thread id. ,
Required: True ,
}
string ,
topic:
{
Description: Chat thread topic. ,
Required: True ,
}
string ,
createdOn:
{
Description: The timestamp when the chat thread was created. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
createdByCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
deletedOn:
{
Description: The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
retentionPolicy:
{
Description: Data retention policy for auto deletion. ,
Required: False ,
}
{
kind:
{
Description: Retention Policy Type ,
Enum:
{
threadCreationDate: Thread retention policy based on thread creation date. ,
none: No thread retention policy ,
}
,
Required: True ,
}
enum ,
}
,
}
,
invalidParticipants:
{
Description: The participants that failed to be added to the chat thread. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
Chat_ListChatThreads (new)
Description :  Gets the list of chat threads of a user.
Reference :  Link ¶

⚼ Request

GET:  /chat/threads
{
maxPageSize:
{
Description: The maximum number of chat threads returned per page. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The earliest point in time to get chat threads up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of chat threads. ,
Required: True ,
}
[
{
id:
{
Description: Chat thread id. ,
Required: True ,
}
string ,
topic:
{
Description: Chat thread topic. ,
Required: True ,
}
string ,
deletedOn:
{
Description: The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessageReceivedOn:
{
Description: The timestamp when the last message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: If there are more chat threads that can be retrieved, the next link will be populated. ,
Required: False ,
}
string ,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_UpdateChatThreadProperties (new)
Description :  Updates a thread's properties.
Reference :  Link ¶

⚼ Request

PATCH:  /chat/threads/{chatThreadId}
{
chatThreadId:
{
Description: The id of the thread to update. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
updateChatThreadRequest:
{
Description: Request payload for updating a chat thread. ,
Required: True ,
}
{
topic:
{
Description: Chat thread topic. ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
retentionPolicy:
{
Description: Data retention policy for auto deletion. ,
Required: False ,
}
{
kind:
{
Description: Retention Policy Type ,
Enum:
{
threadCreationDate: Thread retention policy based on thread creation date. ,
none: No thread retention policy ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_GetChatThreadProperties (new)
Description :  Gets a chat thread's properties.
Reference :  Link ¶

⚼ Request

GET:  /chat/threads/{chatThreadId}
{
chatThreadId:
{
Description: Id of the thread. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Chat thread id. ,
Required: True ,
}
string ,
topic:
{
Description: Chat thread topic. ,
Required: True ,
}
string ,
createdOn:
{
Description: The timestamp when the chat thread was created. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
createdByCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number in E.164 format. ,
Required: True ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
deletedOn:
{
Description: The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
retentionPolicy:
{
Description: Data retention policy for auto deletion. ,
Required: False ,
}
{
kind:
{
Description: Retention Policy Type ,
Enum:
{
threadCreationDate: Thread retention policy based on thread creation date. ,
none: No thread retention policy ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
Chat_DeleteChatThread (new)
Description :  Deletes a thread.
Reference :  Link ¶

⚼ Request

DELETE:  /chat/threads/{chatThreadId}
{
chatThreadId:
{
Description: Id of the thread to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_SendTypingNotification (new)
Description :  Posts a typing event to a thread, on behalf of a user.
Reference :  Link ¶

⚼ Request

POST:  /chat/threads/{chatThreadId}/typing
{
chatThreadId:
{
Description: Id of the thread. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
sendTypingNotificationRequest:
{
Description: Details of the typing notification request. ,
Required: False ,
}
{
senderDisplayName:
{
Description: The display name of the typing notification sender. This property is used to populate sender name for push notifications. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}